[FC-0072] iOS Mobile Plugin Architecture #528

IvanStepanok · 2024-10-11T08:50:53Z

Plugin System Integration for Open edX iOS Mobile Application

This PR introduces a plugin architecture to the Open edX mobile app for iOS platforms. By modularizing functionalities such as analytics and external dependencies into plugins, this enhancement aims to improve the app's extensibility and scalability. It allows for company-specific customizations without the need to modify the core codebase.

Key Changes:

Plugin Interface and Manager:
- Implemented a protocol-based plugin system using OEXFoundation, enabling developers to create and integrate custom plugins seamlessly.
- Added a PluginManager to handle the initialization and management of plugins within the application.
Core Application Update:
- Restructured the app to focus on essential functions, delegating extended features like analytics to plugins.
- Removed hard-coded dependencies on FirebaseAnalytics and FullStory from the core project.
Firebase Analytics Plugin:
- Integrated FirebaseAnalytics using the new OEXFirebaseAnalytics plugin, conforming to the analytics protocols defined in OEXFoundation.
- This allows for easier swapping or addition of analytics services in the future.
Library Migration to OEXFoundation:
- Moved common libraries and dependencies to the OEXFoundation package for centralized management:
  - Alamofire (Networking)
  - Kingfisher (Image Loading)
  - SwiftUI-Introspect (UI Enhancements)
  - Swinject (Dependency Injection)
  - SwiftLintPlugins (Linting)

Objectives:

Extensibility:
- Enables adding new features and services without altering the core application code.
- Facilitates the development and integration of third-party plugins by the community.
Customization:
- Allows organizations to build and configure their own plugins to meet specific business needs.
- Supports company-specific implementations of analytics, payment systems, and more.
Separation of Concerns:
- Simplifies maintenance by isolating features into self-contained modules.
- Enhances code readability and manageability by reducing dependencies in the core project.
Scalability:
- Provides a scalable architecture that can grow with additional plugins and features over time.
- Improves the app's ability to adapt to new technologies and services.

Additional Notes:

Plugin Development:
- Developers can create custom plugins by implementing the protocols defined in OEXFoundation.
- Plugins can be distributed as Swift Packages, making them easy to integrate and share.
Version Consistency:
- Ensured that the versions of OEXFoundation used in the core app and plugins are consistent to maintain compatibility.

This update makes the Open edX iOS mobile app more adaptable to various business needs, fostering a sustainable and flexible framework for ongoing development. By adopting a plugin-based architecture, the app is better positioned for future enhancements and contributions from the developer community.

openedx-webhooks · 2024-10-11T08:50:58Z

Thanks for the pull request, @IvanStepanok!

What's next?

Please work through the following steps to get your changes ready for engineering review:

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
- This process (including the steps you'll need to take) is documented here.
If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

Dependencies

This PR must be merged before / after / at the same time as ...
Blockers

This PR is waiting for OEP-1234 to be accepted.
Timeline information

This PR must be merged by XX date because ...
Partner information

This is for a course on edx.org.
Supporting documentation
Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/openedx-mobile-maintainers. Tag them in a comment and let them know that your changes are ready for review.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

The size and impact of the changes that it introduces
The need for product review
Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

forgotvas · 2024-11-04T18:35:50Z

Profile/ProfileTests/Presentation/DeleteAccount/DeleteAccountViewModelTests.swift

@@ -9,6 +9,7 @@ import SwiftyMocky
 import XCTest
 @testable import Core
 @testable import Profile
+import OEXFoundation
 import Alamofire


If you moved Alamofire to OEXFoundation i think then we should remove import that framework from main base code. Need to implement accessors for alamofire requests. For my side it would be logic that you just import OEXFoundation and able to use Alamofire's methods. Accessors could be named same as Alamofire's methods.

Same for other moved frameworks.

Thank you for the suggestion! We discussed the idea of creating wrappers for all libraries, including Alamofire, and concluded that at this stage, it would add complexity and slow down development.
The main reasons we decided to stick with direct imports for now are:

Need to cover all functionalities — creating wrappers for all required methods would take significant time, and in the future, it could slow down development as each new need would require adding a wrapper first.

Potential loss of flexibility — using libraries directly provides immediate access to all their functionalities. With wrappers, access to new or specialized functions may be limited, making development more challenging.

Increased maintenance costs — every new library version might require updating wrappers and verifying compatibility, leading to additional maintenance overhead.

We’ll definitely revisit this idea if a more isolated architecture is needed, but for now, we’ve decided to keep direct imports to ensure greater flexibility and development speed.

forgotvas · 2024-11-04T18:39:56Z

And one more - we need to think about procedure or maybe PR format style when you want to make changes to OEXFoundation and upstream code at same time. Maybe we just should add link each to other, maybe something else. Just to reviewer could see for what feature author made changes in OEXFoundation.

volodymyr-chekyrta · 2024-11-05T08:36:53Z

And one more - we need to think about procedure or maybe PR format style when you want to make changes to OEXFoundation and upstream code at same time. Maybe we just should add link each to other, maybe something else. Just to reviewer could see for what feature author made changes in OEXFoundation.

Makes sense 👍
The first thing to be introduced is a PR to the foundation with an idea/abstraction, followed by a PR to the application (with a link to the original PR to the foundation)

rnr · 2024-11-05T14:16:03Z

Core/Core/Extensions/Notification.swift

@@ -13,7 +13,6 @@ public extension Notification.Name {
    static let onCourseEnrolled = Notification.Name("onCourseEnrolled")
    static let onblockCompletionRequested = Notification.Name("onblockCompletionRequested")
    static let onTokenRefreshFailed = Notification.Name("onTokenRefreshFailed")
-    static let onActualVersionReceived = Notification.Name("onActualVersionReceived")


only this one is moved to OEXFoundation?

Yes, here: https://github.com/openedx/openedx-app-foundation-ios/blob/main/Sources/OEXFoundation/Network/API.swift#L79-L83

rnr · 2024-11-05T14:31:00Z

OpenEdX/Managers/PluginManager.swift

+import Foundation
+import Core
+import OEXFoundation
+import OEXFirebaseAnalytics


do we need this import here?

rnr · 2024-11-05T14:45:22Z

OpenEdX/Managers/PushNotificationsManager/PushNotificationsManager.swift

 import UIKit
 import UserNotifications
+import OEXFirebaseAnalytics


do we need this import here?

rnr · 2024-11-05T14:46:55Z

OpenEdX/Managers/PushNotificationsManager/Providers/FCMProvider.swift

@@ -7,6 +7,8 @@

 import Foundation
 import Core
+import OEXFoundation
+import OEXFirebaseAnalytics


do we need this OEXFirebaseAnalytics import here?

OEXFoundation needed for API class
OEXFirebaseAnalytics removed

rnr · 2024-11-05T15:08:14Z

config_script/whitelabel.py

-                        config_folder = config_settings.get(self.CONFIG_MAPPINGS, {}).get(config['env_config'])
-                        if config_folder:
-                            # replace fullstory flag
-                            project_file_string = self.replace_fullstory_flag(project_file_string, config_directory, name, config_folder, errors_texts)


@IvanStepanok Maybe it would be better to comment out that line, rather than removing the whole ‘for’ loop?
Without this part, the whole set_flags_from_mobile_config(self): function is meaningless. We could leave this as an example how to work with other flags in project file. WDYT? Thank you

makes sense, thanks!

IvanStepanok · 2024-11-05T15:39:30Z

@rnr Thanks for review, ready for the next part!

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Oct 11, 2024

IvanStepanok added 6 commits November 4, 2024 14:30

feat: connect oexfoundation library to project

60bcaf5

fix: update library version

e0cc168

fix: change package version

2e9855b

feat: connect OEXFoundation to project

17d75de

fix: update OEXFoundation library url and version

540c918

fix: address feedback

16fd879

IvanStepanok force-pushed the feat/connect-OEXFoundation-to-project branch from 2aa83ba to 16fd879 Compare November 4, 2024 12:55

fix: update mocks

1c91041

IvanStepanok changed the title ~~Feat: connect OEXFoundation to project~~ [FC-0072] iOS Mobile Plugin Architecture Nov 4, 2024

IvanStepanok marked this pull request as ready for review November 4, 2024 14:08

IvanStepanok and others added 3 commits November 4, 2024 16:10

Merge branch 'develop' into feat/connect-OEXFoundation-to-project

62cda0c

fix: update fastline

a0c24c8

fix: address feedback

dd10adb

volodymyr-chekyrta previously approved these changes Nov 4, 2024

View reviewed changes

volodymyr-chekyrta requested review from rnr and forgotvas November 4, 2024 15:02

fix: move msal to main module

fd7c721

IvanStepanok dismissed volodymyr-chekyrta’s stale review via fd7c721 November 4, 2024 15:38

forgotvas reviewed Nov 4, 2024

View reviewed changes

forgotvas previously approved these changes Nov 5, 2024

View reviewed changes

rnr reviewed Nov 5, 2024

View reviewed changes

fix: address feedback

a060146

IvanStepanok dismissed forgotvas’s stale review via a060146 November 5, 2024 15:37

rnr approved these changes Nov 5, 2024

View reviewed changes

volodymyr-chekyrta merged commit 5645bce into openedx:develop Nov 5, 2024
7 checks passed

IvanStepanok mentioned this pull request Nov 6, 2024

Develop to main. Release v2 #538

Merged

mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Nov 26, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FC-0072] iOS Mobile Plugin Architecture #528

[FC-0072] iOS Mobile Plugin Architecture #528

IvanStepanok commented Oct 11, 2024 •

edited

Loading

openedx-webhooks commented Oct 11, 2024 •

edited

Loading

forgotvas Nov 4, 2024 •

edited

Loading

IvanStepanok Nov 5, 2024

forgotvas commented Nov 4, 2024

volodymyr-chekyrta commented Nov 5, 2024

rnr Nov 5, 2024

IvanStepanok Nov 5, 2024

rnr Nov 5, 2024

IvanStepanok Nov 5, 2024

rnr Nov 5, 2024

IvanStepanok Nov 5, 2024

rnr Nov 5, 2024

IvanStepanok Nov 5, 2024

rnr Nov 5, 2024

IvanStepanok Nov 5, 2024

IvanStepanok commented Nov 5, 2024

[FC-0072] iOS Mobile Plugin Architecture #528

[FC-0072] iOS Mobile Plugin Architecture #528

Conversation

IvanStepanok commented Oct 11, 2024 • edited Loading

openedx-webhooks commented Oct 11, 2024 • edited Loading

What's next?

🔘 Get product approval

🔘 Provide context

🔘 Get a green build

🔘 Let us know that your PR is ready for review:

Who will review my changes?

Where can I find more information?

When can I expect my changes to be merged?

forgotvas Nov 4, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

forgotvas commented Nov 4, 2024

volodymyr-chekyrta commented Nov 5, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

IvanStepanok commented Nov 5, 2024

IvanStepanok commented Oct 11, 2024 •

edited

Loading

openedx-webhooks commented Oct 11, 2024 •

edited

Loading

forgotvas Nov 4, 2024 •

edited

Loading